Skip to main content

HTML Template

HtmlTemplate

Generates HTML from AsciiDoc files from Apache Freemarker templates.

Description​

A Reporter that creates HTML files from Apache Freemarker templates.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      HtmlTemplate:
        options:
          templateIds: <OPTIONAL_STRING_LIST>
          templatePaths: <OPTIONAL_STRING_LIST>

Options​

templateIds​

STRING_LIST

Alias: template.id

A comma-separated list of IDs of templates provided by ORT. If no template id or path is provided, the "disclosure_document" template is used, and if the ORT result contains an advisor run, the "vulnerability_report" template is used as well.

templatePaths​

STRING_LIST

Alias: template.path

A comma-separated list of paths to template files provided by the user.